<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>log_level</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Boost.Test">
<link rel="up" href="../rt_param_reference.html" title="Runtime parameters reference">
<link rel="prev" href="log_format.html" title="log_format">
<link rel="next" href="log_sink.html" title="log_sink">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="log_format.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rt_param_reference.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="log_sink.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_test.utf_reference.rt_param_reference.log_level"></a><a class="link" href="log_level.html" title="log_level"><code class="computeroutput"><span class="identifier">log_level</span></code></a>
</h4></div></div></div>
<p>
          Parameter <span class="emphasis"><em>log_level</em></span> allows to set the <span class="emphasis"><em>Unit
          Test Framework</em></span> <a class="link" href="../../test_output/logging_api/log_ct_log_level.html#ref_log_level_explanations">log
          level</a>. Log level defines the verbosity of the testing log produced
          by a testing module. The verbosity ranges from a complete log, when all
          assertions (both successful and failing) are reported and all notifications
          about test units start and finish are included, to an empty log, when nothing
          is reported to a testing log stream.
        </p>
<p>
          Log level is set to one of the predefined levels which are organized hierarchically,
          where each level includes all the messages on that level as well as all
          the messages from levels below. Levels are identified by string names,
          which are listed next.
        </p>
<h5>
<a name="boost_test.utf_reference.rt_param_reference.log_level.h0"></a>
          <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.log_level.acceptable_values"></a></span><a class="link" href="log_level.html#boost_test.utf_reference.rt_param_reference.log_level.acceptable_values">Acceptable
          values</a>
        </h5>
<p>
          Following is the list of <a class="link" href="../rt_param_reference.html#enum_param_value">enumeration</a>
          log_level names ordered from higher to lower level. Thus each level includes
          messages on that level as well as all the messages on levels defined below.
        </p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Value
                  </p>
                </th>
<th>
                  <p>
                    Included messages
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    all (default for JUNIT)
                  </p>
                </td>
<td>
                  <p>
                    All log messages including the passed assertions notification
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    success
                  </p>
                </td>
<td>
                  <p>
                    The same as all
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    test_suite
                  </p>
                </td>
<td>
                  <p>
                    Test units start/finish notifications
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    message
                  </p>
                </td>
<td>
                  <p>
                    User generated messages (using <a class="link" href="../testout_reference/test_output_macro_message.html" title="BOOST_TEST_MESSAGE"><code class="computeroutput"><span class="identifier">BOOST_TEST_MESSAGE</span></code></a> tool)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    warning
                  </p>
                </td>
<td>
                  <p>
                    Messages describing failed assertion on <code class="computeroutput"><span class="identifier">WARN</span></code>
                    level ( <a class="link" href="../testing_tool_ref/assertion_boost_test_universal_macro.html" title="BOOST_TEST"><code class="computeroutput"><span class="identifier">BOOST_TEST_WARN</span></code></a> / <code class="computeroutput"><span class="identifier">BOOST_WARN_</span><span class="special">...</span></code>
                    tools)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <span class="bold"><strong>error</strong></span> (default for HRF and XML)
                  </p>
                </td>
<td>
                  <p>
                    Messages describing failed assertion on <code class="computeroutput"><span class="identifier">CHECK</span></code>
                    level (<a class="link" href="../testing_tool_ref/assertion_boost_test_universal_macro.html" title="BOOST_TEST"><code class="computeroutput"><span class="identifier">BOOST_TEST</span></code></a> / <code class="computeroutput"><span class="identifier">BOOST_CHECK_</span><span class="special">...</span></code>
                    tools)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    cpp_exception
                  </p>
                </td>
<td>
                  <p>
                    Messages reporting uncaught C++ exception
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    system_error
                  </p>
                </td>
<td>
                  <p>
                    Messages reporting system originated non-fatal errors. For example,
                    timeout or floating point exception.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    fatal_error
                  </p>
                </td>
<td>
                  <p>
                    Messages reporting user or system originated fatal errors. For
                    example, memory access violation. Also all the messages describing
                    failed assertion on <code class="computeroutput"><span class="identifier">REQUIRE</span></code>
                    level (<a class="link" href="../testing_tool_ref/assertion_boost_test_universal_macro.html" title="BOOST_TEST"><code class="computeroutput"><span class="identifier">BOOST_TEST_REQUIRE</span></code></a> /
                    <code class="computeroutput"><span class="identifier">BOOST_REQUIRE_</span><span class="special">...</span></code> tools)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    nothing
                  </p>
                </td>
<td>
                  <p>
                    No messages are reported.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
<div class="caution"><table border="0" summary="Caution">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../../../../../../../doc/src/images/caution.png"></td>
<th align="left">Caution</th>
</tr>
<tr><td align="left" valign="top"><p>
            the JUNIT log format does not accept the log level to change: anything
            specified by <code class="computeroutput"><span class="identifier">log_level</span></code>
            will be ignored for the JUNIT format.
          </p></td></tr>
</table></div>
<h5>
<a name="boost_test.utf_reference.rt_param_reference.log_level.h1"></a>
          <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.log_level.command_line_syntax"></a></span><a class="link" href="log_level.html#boost_test.utf_reference.rt_param_reference.log_level.command_line_syntax">Command
          line syntax</a>
        </h5>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
              <code class="computeroutput"><span class="special">--</span><span class="identifier">log_level</span><span class="special">=&lt;</span><span class="identifier">level</span><span class="special">&gt;</span></code>
            </li>
<li class="listitem">
              <code class="computeroutput"><span class="special">-</span><span class="identifier">l</span>
              <span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span></code>
            </li>
</ul></div>
<h5>
<a name="boost_test.utf_reference.rt_param_reference.log_level.h2"></a>
          <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.log_level.environment_variable"></a></span><a class="link" href="log_level.html#boost_test.utf_reference.rt_param_reference.log_level.environment_variable">Environment
          variable</a>
        </h5>
<pre class="programlisting"><span class="identifier">BOOST_TEST_LOG_LEVEL</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2001-2020 Boost.Test contributors<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="log_format.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rt_param_reference.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="log_sink.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
